<?xml version="1.0" encoding="UTF-8"?>
<!--
To change this template, choose Tools | Templates
and open the template in the editor.
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
        <title>userguide.html</title>
    </head>
    <body>
        <tt/>
        <h1> CUSTOMER SERVICE REPRESENTATIVE APPLICATION BODGITT AND SCARPER LLC.</h1>
        <p>
            <b>
               THERE ARE MAINLY THREE AREAS FOR CONFIGURING AND USING THE BODGITT AND SCARPER LLC. CSR APPLICATION:
            </b>
        </p>
        <ol TYPE="1">
            <li>
                <h2> SERVER SIDE CONFIGURATION: </h2>
                <ol TYPE="i">
                    <li>
                        <h3> RMI SERVER CONFIGURATION SCREEN:</h3>
                        <ol TYPE="A">
                            <li>
                                <h3>MANUALLY ENTER THE PARAMETERS FOR RMI SERVER:</h3>
                                      
                     
                                        <dl>
                                            <dt>RMI SERVER HOST:</dt>
                                                <dd>In this TextField enter the hostname or the ip address of the host where rmi server is running</dd>
                                            <dt>RMI SERVER URL:</dt>
                                                <dd>In this TextField enter the location relative to the host name to refer to the location where RMI Server Instance is bound</dd>
                                            <dt>RMI PORT:</dt>
                                                <dd>In this TextField enter the Port number where the RMI Server will be listening for incoming requests</dd>
                                            <dt>START BUTTON:</dt>
                                                <dd> Click this button after correctly entering the parameters for RmiServer Configuration in the above three fields,
                                                    This will store the parameters entered by you and start the RmiServer at the specified URL and PORT</dd>
                                        </dl>
                                      
                            </li>
                            <li>
                                <h3>SELECT THE CONFIGURATION USED IN THE PREVIOUS RUN:</h3>
                               
                                <dl>
                                    <dt>START BUTTON:</dt>
                                    <dd>Click this button to start the RMI Server according to the the default configuration or the configuraion
                                    used last time</dd>
                                </dl>
                             
                            </li>
                        </ol>

                    </li>
                    <li>
                        <h3>CHOOSE DATABASE LOCATION SCREEN:</h3>
                        <b>You can choose any one of the following ways to select a database file for the application</b>
                        <ol TYPE="A">
                            <li>
                                <h3>Enter the Path to locate the database file:</h3>
                                <dl>
                                    <dt>DATABASE LOCATION:</dt>
                                        <dd>Enter the Path to database file</dd>
                                    <dt>SUBMIT BUTTON:</dt>
                                        <dd>Click this button to submit the path from where server can find a database file for the application</dd>
                                </dl>


                            </li>
                            <li>
                                <h3>Browse the database File on the Local Machine:</h3>
                                <dl>
                                    <dt>CHOOSE A DBFILE:</dt>
                                        <dd>Click button 'CHOOSE' to browse the File System to find the database on the local machine</dd>
                                </dl>
                            </li>
                            <li>
                                <h3>Use the default database file or the file used in previous runs:</h3>
                                <dt>CHOOSE PREVIOUS DB LOCATION:</dt>
                                <dd> Click the button 'DEFAULT' to select the file which is default configuration or the file used in previous run</dd>
                            </li>
                        </ol>
                    </li>
                </ol>
            </li>
            <li>
                <h2> CLIENT SIDE CONFIGURATION: </h2>
                <b> CLIENT CAN BE CONFIGURED AS LOCAL OR NETWORKED MODE WHICH CAN BE CHOSEN WHILE STARTING THE APPLICATION FROM COMMAND LINE.
                    YOUR CONFIGURATION SCREEN DEPENDS ON THE MODE SELECTED
                </b>
                <ol TYPE="i">
                    <li>
                        
                        <h3> NETWORKED MODE RMI CONFIGURATION SCREEN:</h3>
                        <ol TYPE="A">
                            <li>
                                <h3>MANUALLY ENTER THE PARAMETERS TO CONNECT TO THE RMI SERVER:</h3>


                                        <dl>
                                            <dt>RMI SERVER HOST:</dt>
                                                <dd>In this TextField enter the hostname or the ip address of the host where rmi server is running</dd>
                                            <dt>RMI SERVER URL:</dt>
                                                <dd>In this TextField enter the location relative to the host name to refer to the location where RMI Server Instance is bound</dd>
                                            <dt>RMI PORT:</dt>
                                                <dd>In this TextField enter the Port number where the RMI Server will be listening for incoming requests</dd>
                                            <dt>START BUTTON:</dt>
                                                <dd> Click this button after correctly entering the parameters for RmiServer Configuration in the above three fields,
                                                    This will store the parameters entered by you and bind to remote object running at the host, url and port configured by you
                                                    In networked mode the Client simply connects to the object running an instance of the server and database. The client
                                                    has to work on the database file chosen by the server
                                                </dd>
                                        </dl>
                                     
                            </li>
                            <li>
                                <h3>SELECT THE CONFIGURATION USED IN THE PREVIOUS RUN:</h3>
                            
                                <dl>
                                    <dt>START BUTTON:</dt>
                                    <dd>Click this button to connect to the same RMI object which was recently instantiated
                                    </dd>
                                </dl>
                          
                            </li>
                        </ol>

                    </li>
                    <li>
                        <h3>LOCAL MODE CHOOSE DATABASE LOCATION SCREEN:</h3>
                        <b>You can choose any one of the following ways to select a database file for the application</b>
                        <ol TYPE="A">
                            <li>
                                <h3>Enter the Path to locate the database file:</h3>
                                <dl>
                                    <dt>DATABASE LOCATION:</dt>
                                        <dd>Enter the Path to database file</dd>
                                    <dt>SUBMIT BUTTON:</dt>
                                        <dd>Click this button to submit the path from where server can find a database file for the application</dd>
                                </dl>


                            </li>
                            <li>
                                <h3>Browse the database File on the Local Machine:</h3>
                                <dl>
                                    <dt>CHOOSE A DBFILE:</dt>
                                        <dd>Click button 'CHOOSE' to browse the File System to find the database on the local machine</dd>
                                </dl>
                            </li>
                            <li>
                                <h3>Use the default database file or the file used in previous runs:</h3>
                                <dt>CHOOSE PREVIOUS DB LOCATION:</dt>
                                <dd> Click the button 'DEFAULT' to select the file which is the file used in previous run</dd>
                            </li>
                        </ol>
                    </li>
                </ol>
            </li>
            <li>
                <h2> CUSTOMER SERVICE REPRESENTATIVE USER INTERFACE</h2>
                <b>
                    This is the screen the customer service representatives would be working on while on call with the customer. This screen
                    can be used to book, unbook or search records of interest from the database.
                </b>
                <ol TYPE="i">
                    <li>
                        <h3> CSR CONSOLE</h3>
                        <b> CSR Console has three major areas CSR TABLE, SEARCH CONTRACTORS PANEL, BOOKING PANEL:</b>
                        <ol TYPE="A">
                            <li>
                                <h3>CSR TABLE PANEL:</h3>
                                <b> CSR Table displays each record in the database file.</b>
                                <b> CSR Table consists of seven columns to represent relevant details for each contractor to help the representative choose the contractor base on those requirements:</b>
                                        <dl>
                                                <dt>RECORD NO:</dt>
                                                    <dd>The unique record no. of the contractor in the database file</dd>
                                                <dt>NAME:</dt>
                                                    <dd>Name of the contracting company</dd>
                                                <dt>LOCATION:</dt>
                                                    <dd>Location of the contracting company</dd>
                                                <dt>SPECIALTY:</dt>
                                                    <dd>The type or services contractor can often</dd>
                                                <dt>SIZE:</dt>
                                                    <dd> The number of workers the company has</dd>
                                                <dt>PRICE/HR:</dt>
                                                    <dd> The rate charged by contractor per hour</dd>
                                                <dt>BOOKED BY:</dt>
                                                    <dd> Indicates the customer id if the contractor is already booked, this record is considered unavailable
                                                    for other customers until the record is unbooked</dd>
                                        </dl>
                                <b> To book or unbook a record representative has to select a row from the table, once the row appears highlighted its ready to be booked or unbooked. Only
                                one record can be selected at a time to avoid errors where one customer can book multiple contractors making them unavailable for others.</b>
                            </li>
                            <li>
                                <h3>SEARCH CONTRACTORS PANEL:</h3>
                                <b> This area lets you search the contractors by name and location or get a list of all the contractors</b>
                                <dl>
                                    <dt>NAME TEXT INPUT:</dt>
                                         <dd>Enter the full name or the beginning of the name of a contractor get a list of all the contractors with that name or
                                            beginning with that name.
                                         </dd>
                                    <dt>LOCATION TEXT INPUT:</dt>
                                        <dd>
                                            Same as Name text input. Enter the full name or the beginning of the location of a contractor get a list of all the contractors with that name or
                                            beginning with that name of location.
                                        </dd>
                                    <dt>SEARCH BUTTON:</dt>
                                        <dd>
                                            Displays the list of all the records which match the criteria entered in Name and Location fields. Error messages would pop up if
                                            criteria is null in both the fields or none of the records matched the criteria.
                                        </dd>
                                    <dt>SEARCH ALL BUTTON: </dt>
                                        <dd>
                                            Displays a list of all the records in the database in the table.
                                        </dd>
                                </dl>
                            </li>
                            <li>
                                <h3> BOOKING PANEL: </h3>
                                <b> This area lets representative book or unbook a record selected in the CSR Table, some times the record might be in an old state you might have to refresh the table using
                                the refresh button.</b>
                                <dl>
                                    <dt> CUSTOMER ID TEXT INPUT:</dt>
                                    <dd> Enter a 4 digit customer id to book a contractor for the customer</dd>
                                    <dt> BOOK BUTTON:</dt>
                                    <dd> After entering the customer id the book button will update the value in database for the contractor and make it unavailable to other customers</dd>
                                    <dt> UNBOOK BUTTON:</dt>
                                    <dd> Unbook a selected record if its already booked to make the contractor available to other customers</dd>
                                    <dt> REFRESH BUTTON:</dt>
                                    <dd> Since multiple Representatives are updating the Records every second it is recommended use the refresh button to have an up to date view of the database file
                                    before booking or unbooking a record</dd>
                                    <dt> REFRESH RATES COMBO BOX:</dt>
                                    <dd> Application also refreshes the table automatically at certain intervals to have the most current information, from the drop down menu select the intervals in terms of seconds refresh is desired
                                    </dd>
                                </dl>
                             
                            </li>
                            <li>
                                <h3>EXIT THE APPLICATION:</h3>
                                <b> Click the 'X'(close) button on top right of the window or select "EXIT" from file menu to exit
                                the application.</b>
                            </li>
                        </ol>

                    </li>
                   
                </ol>
            </li>
        </ol>

    </body>
</html>
